Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: refactor "exposed" @system_dir instance variable (in helper method) #604

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: refactor "exposed" @system_dir instance variable (in helper method) #604

wants to merge 1 commit into from

Conversation

pvdb
Copy link
Contributor

@pvdb pvdb commented Nov 11, 2024

It is very unclear why the Rake::TestCase#rake_system_dir helper method:

  def rake_system_dir
    @system_dir = "system"

    FileUtils.mkdir_p @system_dir

    File.write File.join(@system_dir, "sys1.rake"), <<~SYS
      task "sys1" do
        puts "SYS1"
      end
    SYS

    ENV["RAKE_SYSTEM"] = @system_dir
  end

... creates and sets a @system_dir instance variable. 🤔

On inspection, it turns out its only use is the following assertion in one of the test cases:

    assert_equal @system_dir, @app.system_dir

... so this PR removes the ivar and hardcodes the expected "system" value in the assertion:

-    assert_equal @system_dir, @app.system_dir
+    assert_equal "system", @app.system_dir

This may seem a tad controversial, but as it turns out, the sys1.rake Rakefile name and the SYS1 Rakefile contents (also "private" - as it were - to that very same utility method) are already hardcoded in one of the Rake test cases:

$ git grep -i sys1 -- 'test/test*'
test/test_rake_functional.rb:    rake "-g", "sys1"
test/test_rake_functional.rb:    assert_match %r{^SYS1}, @out
test/test_rake_functional.rb:    rake "-g", "sys1", "-T", "extra"
test/test_rake_functional.rb:    rake "sys1", "--trace"
test/test_rake_functional.rb:    assert_match %r{^SYS1}, @out
test/test_rake_functional.rb:    rake "-G", "sys1"
test/test_rake_functional.rb:    rake "--nosearch", "sys1"
test/test_rake_functional.rb:    assert_match %r{^SYS1}, @out
$ _

... so the change in this PR just makes things more consistent with the other test cases and assertions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@pvdb